home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / terms / kermit / e / tuvrta.hlp < prev    next >
Encoding:
Text File  |  1988-08-16  |  6.2 KB  |  148 lines
  1. .help rtar Nov86 softools
  2. .IH
  3. NAME
  4. rtar -- read TAR format archive file
  5. .IH
  6. USAGE
  7. rtar [ flags ] [ archive ] [ after ] [ files ]
  8. .IH
  9. PARAMETERS
  10. .ls 4 -a
  11. Advance to the archive file named by the \fIafter\fR argument before
  12. performing the main operation.  The extract or list operation will begin with
  13. the file \fIafter\fR and continue to the end of the archive.
  14. .le
  15. .ls 4 -b
  16. Output only binary byte stream files.  By default, \fIrtar\fR outputs text
  17. files in the host system textfile format.  The conversion from the byte stream
  18. \fItar\fR format to host textfile format may involve modification of the
  19. file, e.g., conversion from ASCII to EBCDIC.  A binary extraction copies
  20. the file to disk without modification.
  21. .le
  22. .ls 4 -d
  23. Print detailed information about what \fIrtar\fR is doing.
  24. .le
  25. .ls 4 -e
  26. Extract the entire contents of the tape \fIexcluding\fR the files or directories
  27. listed in \fIfiles\fR.
  28. .le
  29. .ls 4 -f filename
  30. \fIRtar\fR uses the first filename argument as the host filename of the
  31. archive instead of reading from \fIstdin\fR.
  32. .le
  33. .ls 4 -l
  34. Do not try to resolve file links by a disk to disk file copy.  By default,
  35. if file A appears in the archive as a link to file B,
  36. \fIrtar\fR trys to resolve the link by performing a disk to disk copy of
  37. file B to A.  This is valid providing file B was present in the archive and
  38. has already been extracted.  If the \fBl\fR flag is present linked files
  39. will not be extracted.
  40. .le
  41. .ls 4 -n
  42. Do not strip trailing blank lines from text files read from the tape.
  43. The default is to strip any blank lines at the ends of files.
  44. This is necessary when the file was written by \fIwtar\fR on a system
  45. like VMS, where the size of the file is not known before it has been
  46. read.  The \fIwtar\fR utility must guess at the final size and pad the
  47. file at the end with spaces to ensure that the size of the file actually
  48. written agrees with the file header.
  49. .le
  50. .ls 4 -o
  51. Omit binary files when performing the extraction.  A binary file is any
  52. file containing ASCII values other than 040 through 0176 (the printable
  53. ASCII characters), tab, or newline in the first 512 byte block of the file.
  54. .le
  55. .ls 4 -p pathprefix
  56. When creating directories and files from the pathnames recorded in the archive,
  57. omit the given path prefix if it matches the pathname given in the archive.
  58. This feature is used to relocate directories, or to read tar archives
  59. containing absolute pathnames.  For example, given "-p /usr/", the archive
  60. pathname "/usr/me/file" would be written to the file "me/file".
  61. .le
  62. .ls 4 -r
  63. The extracted file replaces any existing file of the same name, i.e.,
  64. \fIrtar\fR performs a delete before creating the extracted file.
  65. .le
  66. .ls 4 -t
  67. The names of the specified files are listed each time they occur on
  68. the tape.  If no \fIfiles\fR argument is given, all of the names on the tape
  69. are listed.
  70. .le
  71. .ls 4 -v
  72. Print more information about the tape entries than just their names.
  73. The verbose file list format gives the file permissions, the link flag
  74. (zero if there were no links to the file), the owner and group identification
  75. numbers of the file on the system that wrote the archive, the file size in
  76. bytes, the date of last modification of the file, and the file name.
  77. .le
  78. .ls 4 -x
  79. The named files are extracted from the tape.  If the named file
  80. matches a directory whose contents had been written onto the tape, this
  81. directory is (recursively) extracted.  The owner, modification time, and mode
  82. are restored (if possible).  If no file argument is given, the entire content
  83. of the tape is extracted.  Note that if multiple entries specifying the same
  84. file are on the tape, the last one overwrites all earlier.
  85. .le
  86. .IH
  87. DESCRIPTION
  88. \fIRtar\fR reads multiple files from a UNIX \fItar\fR format file,
  89. restoring the files to disk on the local host machine.
  90. Output filenames are mapped according to the IRAF filenaming conventions
  91. of the local host operating system.
  92.  
  93. \fIRtar\fR's actions are controlled by the \fIflags\fR argument. 
  94. \fIFlags\fR consists of a minus sign followed by a string of characters
  95. containing any combination of the function flags described below.
  96. Other arguments to \fIrtar\fR are the name of the archive file to be read,
  97. the name of the file on the archive at which reading is to begin,
  98. and the names of the files or directories to be read or to be excluded
  99. from the read.  In all cases, appearance of a directory name refers to
  100. the files and (recursively) subdirectories of that directory.
  101.  
  102. All \fIrtar\fR filename arguments are IRAF virtual filenames (or host
  103. filenames), except the prefix strings, which pertain to the tape format
  104. and hence are UNIX pathnames.  Magtape devices may be specified by
  105. their IRAF logical device name (if the "dev$devices" file is in place
  106. and is up to date), or by the host device name, prefixed with a "mt.",
  107. e.g., "mt.MUA1" or "mt./dev/rmt9".
  108.  
  109. If the input archive file is a tape the blocksize must be a multiple
  110. of 512 bytes, with a maximum blocksize of 10240 bytes.  Each archived file
  111. occupies an integral number of 512 byte blocks in the archive (this is
  112. required by the \fItar\fR format).
  113.  
  114. Filenames appearing in the file list are interpreted as prefix strings,
  115. i.e., a match occurs if the given string is a prefix of an actual filename
  116. in the archive.  If the last character in the \fIfiles\fR filename is
  117. a \fB$\fR then an exact match is required (excluding the $ metacharacter).
  118. .IH
  119. DIAGNOSTICS
  120. A file read error occurring while reading the archive file is fatal unless
  121. caught and corrected by the host system.
  122. File header checksum errors result in skipping of the archive file
  123. currently being read, with execution continuing with the next archive
  124. file if possible.
  125. File write errors on the output file are reported but do not cause
  126. termination of \fIrtar\fR.  The output file being written will be corrupted.
  127. .ih
  128. EXAMPLES
  129. Since \fIrtar\fR is a bootstrap utility implemented as a foreign task in
  130. the CL, it may be called either from within the CL (as in the examples),
  131. or at the host system level.  The command syntax is identical on both cases.
  132.  
  133. 1. List the contents of the disk archive file "arc".
  134.  
  135.     cl> rtar -tvf arc
  136.  
  137. 2. Unpack the tape archive on drive A in the current directory.
  138.  
  139.     cl> rtar -xf mta
  140. .IH
  141. BUGS
  142. The current limit on file name length is 100 characters (this restriction
  143. is imposed by the standard UNIX \fItar\fR format).
  144. File links are not recreated.
  145. .ih
  146. SEE ALSO
  147. wtar, rmbin
  148.